<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IDocumentSummary</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IDocumentSummary</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents a document summary in a <a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a>.</p>
<p class="description"><p>The document summary contains a set of fields defined in the configuration  of the search engine returning the results.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IDocumentSummary.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---result---IDocumentSummary.php.html">/src/sde/fastsearch/result/IDocumentSummary.php</a> (line <span class="field">35</span>)
		</p>
		
				
		<pre><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a>
   |
   --IDocumentSummary</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#fieldCount" title="details" class="method-name">fieldCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getDocNo" title="details" class="method-name">getDocNo</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>
										<a href="#getSummaryField" title="details" class="method-name">getSummaryField</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>
										<a href="#getSummaryFieldByName" title="details" class="method-name">getSummaryFieldByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSummaryField" title="details" class="method-name">setSummaryField</a>
											(<span class="var-type"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>&nbsp;<span class="var-name">$field</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#summaryFields" title="details" class="method-name">summaryFields</a>
										()
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodfieldCount" id="fieldCount"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">fieldCount</span> (line <span class="line-number">41</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of fields in this document summary.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			fieldCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDocNo" id="getDocNo"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDocNo</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the document number/index of this document.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getDocNo
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSummaryField" id="getSummaryField"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSummaryField</span> (line <span class="line-number">56</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the summary field at given index $index.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>
		<span class="method-name">
			getSummaryField
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$index</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSummaryFieldByName" id="getSummaryFieldByName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSummaryFieldByName</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the summary field with given name $name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>
		<span class="method-name">
			getSummaryFieldByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetSummaryField" id="setSummaryField"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSummaryField</span> (line <span class="line-number">72</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds an IDocuemntSummaryField. If a field  was with the same name was set before, it will be overridden.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSummaryField
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_result/IDocumentSummaryField.html">IDocumentSummaryField</a></span>&nbsp;<span class="var-name">$field</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">IDocuemntSummaryField</span>
				<span class="var-name">$field</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsummaryFields" id="summaryFields"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">summaryFields</span> (line <span class="line-number">78</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an iterator for the summary fields in this document summary.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			summaryFields
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../sde_fastsearch_result/IResultObject.html#methodprepareUnset">IResultObject::prepareUnset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:07 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>